/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.graphics;
import org.eclipse.swt.*;
/**
* <code>LineAttributes</code> defines a set of line attributes that
* can be modified in a GC.
* <p>
* Application code does <em>not</em> need to explicitly release the
* resources managed by each instance when those instances are no longer
* required, and thus no <code>dispose()</code> method is provided.
* </p>
*
* @see GC#getLineAttributes()
* @see GC#setLineAttributes(LineAttributes)
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
*
* @since 3.3
*/
public class LineAttributes {
/**
* The line width.
*/
public float width;
/**
* The line style.
*
* @see org.eclipse.swt.SWT#LINE_CUSTOM
* @see org.eclipse.swt.SWT#LINE_DASH
* @see org.eclipse.swt.SWT#LINE_DASHDOT
* @see org.eclipse.swt.SWT#LINE_DASHDOTDOT
* @see org.eclipse.swt.SWT#LINE_DOT
* @see org.eclipse.swt.SWT#LINE_SOLID
*/
public int style;
/**
* The line cap style.
*
* @see org.eclipse.swt.SWT#CAP_FLAT
* @see org.eclipse.swt.SWT#CAP_ROUND
* @see org.eclipse.swt.SWT#CAP_SQUARE
*/
public int cap;
/**
* The line join style.
*
* @see org.eclipse.swt.SWT#JOIN_BEVEL
* @see org.eclipse.swt.SWT#JOIN_MITER
* @see org.eclipse.swt.SWT#JOIN_ROUND
*/
public int join;
/**
* The line dash style for SWT.LINE_CUSTOM.
*/
public float[] dash;
/**
* The line dash style offset for SWT.LINE_CUSTOM.
*/
public float dashOffset;
/**
* The line miter limit.
*/
public float miterLimit;
/**
* Create a new line attributes with the specified line width.
*
* @param width the line width
*/
public LineAttributes(float width) {
this(width, SWT.CAP_FLAT, SWT.JOIN_MITER, SWT.LINE_SOLID, null, 0, 10);
}
/**
* Create a new line attributes with the specified line cap, join and width.
*
* @param width the line width
* @param cap the line cap style
* @param join the line join style
*/
public LineAttributes(float width, int cap, int join) {
this(width, cap, join, SWT.LINE_SOLID, null, 0, 10);
}
/**
* Create a new line attributes with the specified arguments.
*
* @param width the line width
* @param cap the line cap style
* @param join the line join style
* @param style the line style
* @param dash the line dash style
* @param dashOffset the line dash style offset
* @param miterLimit the line miter limit
*/
public LineAttributes(float width, int cap, int join, int style, float[] dash, float dashOffset, float miterLimit) {
this.width = width;
this.cap = cap;
this.join = join;
this.style = style;
this.dash = dash;
this.dashOffset = dashOffset;
this.miterLimit = miterLimit;
}
/**
* Compares the argument to the receiver, and returns true
* if they represent the <em>same</em> object using a class
* specific comparison.
*
* @param object the object to compare with this object
* @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
*
* @see #hashCode()
*/
@Override
public boolean equals (Object object) {
if (object == this) return true;
if (!(object instanceof LineAttributes)) return false;
LineAttributes p = (LineAttributes)object;
if (p.width != width) return false;
if (p.cap != cap) return false;
if (p.join != join) return false;
if (p.style != style) return false;
if (p.dashOffset != dashOffset) return false;
if (p.miterLimit != miterLimit) return false;
if (p.dash != null && dash != null) {
if (p.dash.length != dash.length) return false;
for (int i = 0; i < dash.length; i++) {
if (p.dash[i] != dash[i]) return false;
}
} else {
if (p.dash != null || dash != null) return false;
}
return true;
}
/**
* Returns an integer hash code for the receiver. Any two
* objects that return <code>true</code> when passed to
* <code>equals</code> must return the same value for this
* method.
*
* @return the receiver's hash
*
* @see #equals(Object)
*/
@Override
public int hashCode () {
int hashCode = Float.floatToIntBits(width);
hashCode = 31 * hashCode + cap;
hashCode = 31 * hashCode + join;
hashCode = 31 * hashCode + style;
hashCode = 31 * hashCode + Float.floatToIntBits(dashOffset);
hashCode = 31 * hashCode + Float.floatToIntBits(miterLimit);
if (dash != null) {
for (int i = 0; i < dash.length; i++) {
hashCode = 31 * hashCode + Float.floatToIntBits(dash[i]);
}
}
return hashCode;
}
}